/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsrm;

import java.util.Calendar;

import org.apache.xmlbeans.XmlObject;

import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.schemas.wsrm.SequenceRefDocument;
/** 
    This is a utility class which facilitates the creation of WsrmSequence
    Policies, and also the addition of policy elements besides the 
    serialization/de-serialization of the policies.
     
    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:30 $
    $Revision: 1.5 $
*/

public interface WsrmSequencePolicyFactory {

  /** Construct a sequence policies instance using the XmlCursor instance
      that has been provided. */
  public WsrmSequencePolicies createWsrmSequencePolicies(XmlObject xmlObject);


  /** Get a default wsrm sequence policies element */
  public WsrmSequencePolicies getDefaultWsrmSequencePolicies();


  /** Update the expiry associated with a sequence. This can happen due to
      a new expiry value being specified within a Sequence element. */
  public void updateExpiry(WsrmSequencePolicies wsrmSequencePolicies,
			   Calendar expiresAt);
  
  
  /** Create a sequence policies instance based on its marshalled
      representation. */
  public WsrmSequencePolicies 
  getWsrmSequencePolicies(byte[] marshalledBytes);


  /** Get the sequenceRef document. The way this method works is as follows.
      SequenceRef elements should be contained within the wsp:AppliesTo 
      element which in turn must be encapsulated within a PolicyAttachment
      element. If any of the predecessors are missing, this method will 
      return a NULL. */
  public SequenceRefDocument 
  getSequenceRefDocument(EnvelopeDocument envelopeDocument);
}
